Documentation for build-depends on hover #4385
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fendor
requested changes
Aug 20, 2024
fendor
approved these changes
Aug 22, 2024
Co-authored-by: fendor <[email protected]>
fendor
reviewed
Aug 26, 2024
Co-authored-by: fendor <[email protected]>
VeryMilkyJoe
approved these changes
Aug 28, 2024
soulomoon
pushed a commit
to soulomoon/haskell-language-server
that referenced
this pull request
Sep 23, 2024
If you hover over the field under `build-depends` it will give Documentation with a hackage link to a package. Video with an example: * + hover * + hover handler * working prototype * bugfix * rm TODO * + tests * docs * requested changes * - Debug.Trace * schema * Apply suggestions from code review Co-authored-by: fendor <[email protected]> * resolve merge issues * runActionE -> runAction * revert prev, useWithStaleE -> useE * Update plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal.hs Co-authored-by: fendor <[email protected]> * + documentation --------- Co-authored-by: fendor <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for build-depends on hover.
If you hover over the field under
build-dependsit will give Documentation with a hackage link to a package.
Video with an example:
cabal-hover-cut.mp4
Implementation details
This is a naive solution for this problem, hovered text is filtered using
a regex and compared to found dependencies from
PackageDescription.If it was found, then the
Documentationmessage is added, otherwise left as is.This approach assumes, that if a package is mentioned in a cabal file, there should be
a link with the same name. In this implementation there are no spelling checks.